Event Notification APIs 4.0

4.0.x
(0 reviews)

Important Information & Bank of Ireland’s API Implementation

Event Notification Important Information

Event Notification APIs

Important Information & Bank of Ireland’s API Implementation

This page is a reflection of Bank of Ireland’s implementation of the Open Banking Event Notifications APIs.

Events Produced from Access Dashboards: ( Aggregated Polling )

When B365/BOL customer revokes the access from the TPPs for given consents from ASPSP Access Dashboards that results in events being produced. Event type supported is ‘UK.OBIE.Consent-Authorization-Revoked’ .

Currently, the scope includes: -

• AISP & CBPII (Consent revocation from access dashboard) - BOI UK & BOI ROI
• PISP VRP for sweeping (Consent revocation from access dashboard) - BOI UK

Events produced for SEPA Instant Payment ( Real Time Event Notification ):

When B365/BOL customers successfully initiated a SEPA instant payment through via TPP then ASPSP will notify the TPP that an event has occurred . Event Type supported is ‘UK.OBIE.Consent-Resource-Update’ .

Currently, the scope includes: -

• PISP SEPA Instant Payment events – ROI B365 ( BOI to other bank transfers )
• PISP SEPA Instant Payment events – ROI BOL ( Both BOI to BOI and BOI to other bank transfers)

As part of event notification for SEPA Instant Payments:

1.For Single shot payments, BOI will send the following details:
• paymentOrderId
• status

 o For a TPP subscribed to Resource Update Event type, the final status will appear as "ACSC " in both event notification as well as via GET endpoint. However, if
   a TPP has not subscribed to Resource Update Event Type, the final status will remain "ACSP" when checking via GET Endpoint.

 o On failure, the final status will be ”RJCT”.

2.For File Submission, BOI will not send real time event notification to TPP. TPP can hit the GET /file-payments/{FilePaymentId}/report-file endpoint after a minute from successful initiation of file payment to extract the Pain.002 report .

Supported APIs:

Bank of Ireland supports below APIs:

• Event Notification Subscription API.
• Aggregated Polling API
• Real Time Event Notification API

Bank of Ireland does not support the below APIs:
• Callback URL API.

Event-Notification-Subscription-APIs:

Supported Endpoints:

  1. Bank of Ireland supports below subscription endpoints:
     • POST /event-subscriptions
 • GET /event-subscriptions
 • DELETE /event-subscriptions/{EventSubscriptionId}
 • PUT /event-subscriptions/{EventSubscriptionId}

Supported Fields for Event Subscription:

Bank of Ireland supports the following event type:

A.‘UK.OBIE.Consent-Resource-Update’
B.‘UK.OBIE.Consent-Authorization-Revoked’
  1. Bank of Ireland support the ‘CallbackUrl’ field for SEPA instant Real-time event subscription API.

Bank of Ireland will maintain at most, a single event-subscription resource per TPP at any point in time.

2.Aggregated Polling API - POST/Events:

Supported Fields:

1. maxEvents:

•Using this parameter a TPP can request the maximum number of events to be returned in polling. For requests with value greater than 10, BOI will accept the
request but will return a maximum of 10 events in a single API response with moreAvailable flag as ‘True’ if more awaited events are available.
•TPPs can poll again subsequently to receive remaining events.
•If no further events are available the moreAvailable flag will be set to ‘False’ in response to TPP.

2. returnImmediately:

• BOI only supports short polling therefore only ‘True’ value is supported,
• BOI does not support long polling so request with value as ‘False’ will be declined.

3. ack:

• Bank of Ireland does not expect acknowledgments/negative acknowledgments of events from TPPs.
• If passed in request, BOI accepts the request but does not process the acknowledgments.
• Once the events are delivered to the TPPs they are deleted from the queues and cannot be re delivered irrespective of Ack/Nack.

Polling Interval:

BOI does not enforce any polling interval between two consecutive calls for a TPP, however if there are no awaited events available meaning more Available flag is set to ‘False’, we recommend the TPPs to retry after an hour.

Event Recycling Frequency:

BOI does not recycle and reuse the JWT Identifiers.

BOI can only retain the awaited events for a maximum of 14 days after which they are deleted from the queues even if not polled by TPPs.

Reviews